/**
 * Copyright (C) 2010 Hamburg Sud
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.hamburgsud.log4testing.core.data;

/**
 * This class is the same as {@link TestStep} with the difference that it can
 * store a value. For the case that a test method shall return a value in
 * addition to the logging object which provides information about the execution
 * of the test method, a instance of this class can be used. The return value
 * can be stored through {@link #setValue(Object)} and received with the help of
 * {@link #getValue()}.
 * 
 * @param <T>
 *            is the type of the value which can be stored in an object of this
 *            class
 */
public class ValueTestStep<T> extends TestStep {

	/** Value which shall be stored in this class. */
	private T value = null;

	/**
	 * Sets the return value.
	 * 
	 * @param value
	 *            to be set
	 */
	public void setValue(final T value) {
		this.value = value;
	}

	/**
	 * Return value of test method which returns a instance of this class.
	 * 
	 * @return the return value of a test method
	 */
	public T getValue() {
		return value;
	}

}
